List of App Environments

Returns a paginated list of application environments configured for the given Project.

GET{accelqLoginUrl}/awb/api/2.0/{tenantCode}/{projectCode}/conf/app-environments

Headers

Header	Value
`user_id`	Login username (email)
`api_key`	API key of the user for authentication
`Content-Type`	application/json
`Accept`	application/json

Parameters

Parameter	Type	Required	Description
`accelqLoginUrl`	string	Yes	The AccelQ login URL for API access.
`tenantCode`	string	Yes	Tenant code for identifying the organization.
`projectCode`	string	Yes	Project Code found under Auth properties of ACCELQ User Profile
`page`	integer	No	Page number for pagination.
`pageSize`	integer	No	Number of items per page (Maximum: 100).
`user_id`	string	Yes	Login username (email)
`api_key`	string	Yes	API key of the user for authentication

Responses

200 - Returns the list of app environments.

json

{
  "page": 1,
  "pageSize": 10,
  "totalPages": 3,
  "totalCount": 21,
  "results": [
    {
      "pid": 1,
      "appEnvironmentName": "Staging",
      "description": "Staging Environment"
    },
    {
      "pid": 2,
      "appEnvironmentName": "Prod",
      "description": "Prod Environment"
    },
    {
      "pid": 3,
      "appEnvironmentName": "Live",
      "description": "Live Environment"
    },
    {
      "pid": 5,
      "appEnvironmentName": "Staging 2",
      "description": "Staging Environment"
    },
    {
      "pid": 6,
      "appEnvironmentName": "Test",
      "description": "Test Environment"
    },
    {
      "pid": 31,
      "appEnvironmentName": "Sample",
      "description": "Environment"
    },
    {
      "pid": 38,
      "appEnvironmentName": "Prod 2",
      "description": "Prod2 Environment"
    },
    {
      "pid": 39,
      "appEnvironmentName": "Staging 3",
      "description": ""
    },
    {
      "pid": 41,
      "appEnvironmentName": "Patch",
      "description": "Patch Environment"
    },
    {
      "pid": 44,
      "appEnvironmentName": "Next Release",
      "description": "Environment"
    }
  ]
}

403 - Forbidden - User does not have permission to fetch app environments

json

{
  "error": "User do not have authorization to access this feature."
}

422 - Project not found.

json

{
  "error": "Project with code 'proj123' not found."
}

cURL Command Builder

URL Parameters

accelqLoginUrl (string) *

tenantCode (string) *

projectCode (string) *

page (integer)

pageSize (integer)

Headers

user_id (string) *

api_key (string) *

Request Sample (cURL)

curl -X GET "${{accelqLoginUrl}}/awb/api/2.0/${{tenantCode}}/${{projectCode}}/conf/app-environments?page=${{page}}&pageSize=${{pageSize}}" \
  -H "user_id: ${{user_id}}" \
  -H "api_key: ${{api_key}}" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json"